﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

#pragma once

#include "GcmpModelInterface.h"

namespace gcmp
{
    class IElementShapeHandle;
    class IModelView;
    class IDrawingTable;
    /// \brief  表格夹点配置
    ///
    /// GCMP提供实现，不允许外部派生。
    FINAL_INTERFACE class GCMP_MODEL_INTERFACE_EXPORT IDrawingTableGripPointsConfig
    {
    public:
        /// \brief 析构函数
        virtual ~IDrawingTableGripPointsConfig() = default;

        /// \brief 获取表格夹点配置管理器
        ///
        /// \return 表格夹点配置管理器指针
        static IDrawingTableGripPointsConfig* Get();

        /// \brief 设置是否生成表格中单元格的夹点
        ///
        /// 设置之后，再次生成表格夹点时起效；全局起效
        /// \param isNeedDrawingTableItemGripPoints 是否生成表格中单元格的夹点
        /// \return true-设置成功；false-设置失败
        virtual bool SetIsNeedDrawingTableItemGripPoints(bool isNeedDrawingTableItemGripPoints) = 0;

        /// \brief 是否生成表格中单元格的夹点
        ///
        /// \return 返回是否生成表格中单元格的夹点。true-生成表格中单元格的夹点；false-不生成表格中单元格的夹点
        virtual bool IsNeedDrawingTableItemGripPoints() const = 0;


        /// \brief 函数封装器，用于存储“表格扩展辅助对象的回调函数”
        ///
        /// \param pModelView 当前视图
        /// \param pDrawingTable 需要扩展辅助夹点的表格
        /// \return 返回扩展出的表格辅助对象集合
        typedef std::function<std::vector<gcmp::IElementShapeHandle*>(const gcmp::IModelView* pModelView, const gcmp::IDrawingTable* pDrawingTable)> ExternalTableShapeHandleCallBack;

        /// \brief 设置表格扩展辅助对象的回调函数
        ///
        /// 该回调函数主要提供用户时机在生成表格单元格内置夹点之外再生成自定义的辅助对象。
        /// 目前内置的表格夹点index为正数，为了避免与内置夹点index冲突，建议扩展夹点index以负数为主
        /// \param callback 用户自定义的表格扩展辅助对象的回调函数
        /// \return 设置成功返回true，失败返回false
        virtual bool SetExternalShapeHandleCallBack(ExternalTableShapeHandleCallBack callback) = 0;
    };
}

